﻿//
// HomingStatusEventArgs.cs
//
// Authors:
//    Claus Jørgensen <10229@iha.dk>
//    Jens Bloch Christensen <09584@iha.dk>
//    Jonas Daugaard Møller <08814@iha.dk>
//
using System;

namespace NIP.ControllerInterface
{
    /// <summary>
    /// Provides data for the <see cref="E:USBC.HomingStatusChanged"/>
    /// and <see cref="E:USBC.ReturnedHome"/> events.
    /// </summary>
    public class HomingStatusEventArgs : EventArgs
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="T:HomingStatusEventArgs"/> class
        /// </summary>
        /// <param name="homingStatus">
        /// The robots homing status.
        /// </param>
        public HomingStatusEventArgs(HomingStatus homingStatus)
        {
            this.HomingStatus = homingStatus;
        }

        /// <summary>
        /// Gets the robots homing status.
        /// </summary>
        public HomingStatus HomingStatus
        {
            get;
            private set;
        }
    }
}
